/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.apache.shindig.gadgets.render;

import com.google.common.collect.Multimap;
import com.google.inject.ImplementedBy;

/**
 * Provide information about the set of JSON-RPC services that are available to gadgets running in
 * the context of a specific container
 */
@ImplementedBy(DefaultRpcServiceLookup.class)
public interface RpcServiceLookup {
  /**
   * This result map is a map of the form
   * { endpoint1 -> [services]}, endpoint2 -> [services]}
   *
   * Services are described using the names expected as a result of JSON-RPC call
   * to system.listMethods
   *
   * When a gadget is rendered the container data is mapped into gadgets.config and used to
   * initialize osapi, which typically results in output that looks like
   *
   * { "osapi.services" : { "http://.../endpoint1" : ["system.listMethods", "people.get", "people.create",
   * "people.delete"], ... }, "http://.../endpoint2" : { "system.listMethods", "cache.invalidate"],
   * ... } }}
   * @param container
   * @param host
   * @return
   */
  Multimap<String, String> getServicesFor(String container, String host);
}
